

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Button (lv_btn) &mdash; LittlevGL 6.1.2 documentation</title>
  

  
  
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/fontawesome.min.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Button matrix (lv_btnm)" href="btnm.html" />
    <link rel="prev" title="Bar (lv_bar)" href="bar.html" />
 
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-78811084-3"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'UA-78811084-3');
</script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/white_white_lvgl_full_logo.svg" class="logo" alt="Logo"/>
          
          </a>

          
            
            
              <div class="version">
                6.1.2
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../get-started/index.html">Get started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../get-started/live-demo.html">Live demos</a></li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/pc-simulator.html">Simulator on PC</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/pc-simulator.html#select-an-ide">Select an IDE</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/pc-simulator.html#set-up-eclipse-cdt">Set-up Eclipse CDT</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#install-eclipse-cdt">Install Eclipse CDT</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#install-sdl-2">Install SDL 2</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#pre-configured-project">Pre-configured project</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#add-the-pre-configured-project-to-eclipse-cdt">Add the pre-configured project to Eclipse CDT</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/pc-simulator.html#compile-and-run">Compile and Run</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/quick-overview.html">Quick overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#add-littlevgl-into-your-project">Add LittlevGL into your project</a></li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#learn-the-basics">Learn the basics</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#objects-widgets">Objects (Widgets)</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#styles">Styles</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#events">Events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#examples">Examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#button-with-label">Button with label</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#button-with-styles">Button with styles</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#slider-and-object-alignment">Slider and object alignment</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#list-and-themes">List and themes</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/quick-overview.html#use-littlevgl-from-micropython">Use LittlevGL from Micropython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/quick-overview.html#contributing">Contributing</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../get-started/micropython.html">Micropython</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#what-is-micropython">What is Micropython?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#highlights-of-micropython">Highlights of Micropython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#why-micropython-littlevgl">Why Micropython + LittlevGL?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#here-are-some-advantages-of-using-littlevgl-in-micropython">Here are some advantages of using LittlevGL in Micropython:</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#micropython-littlevgl-could-be-used-for">Micropython + LittlevGL could be used for:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#so-what-does-it-look-like">So what does it look like?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#a-simple-example">A simple example</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#how-can-i-use-it">How can I use it?</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#online-simulator">Online Simulator</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#pc-simulator">PC Simulator</a></li>
<li class="toctree-l4"><a class="reference internal" href="../get-started/micropython.html#embedded-platform">Embedded platform</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../get-started/micropython.html#where-can-i-find-more-information">Where can I find more information?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../porting/index.html">Porting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../porting/sys.html">System overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/project.html">Set-up a project</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#get-the-library">Get the library</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#configuration-file">Configuration file</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/project.html#initialization">Initialization</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/display.html">Display interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#display-buffer">Display buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#display-driver">Display driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/display.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/indev.html">Input device interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#types-of-input-devices">Types of input devices</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#touchpad-mouse-or-any-pointer">Touchpad, mouse or any pointer</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#keypad-or-keyboard">Keypad or keyboard</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#encoder">Encoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../porting/indev.html#button">Button</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#other-features">Other features</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/indev.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/tick.html">Tick interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/tick.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/task-handler.html">Task Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/sleep.html">Sleep management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../porting/os.html">Operating system and interrupts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/os.html#tasks-and-threads">Tasks and threads</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/os.html#interrupts">Interrupts</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../porting/log.html">Logging</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#log-level">Log level</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#logging-with-printf">Logging with printf</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#custom-log-function">Custom log function</a></li>
<li class="toctree-l3"><a class="reference internal" href="../porting/log.html#add-logs">Add logs</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/object.html">Objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#object-attributes">Object attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#basic-attributes">Basic attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#specific-attributes">Specific attributes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/object.html#object-s-working-mechanisms">Object’s working mechanisms</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#parent-child-structure">Parent-child structure</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#moving-together">Moving together</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#visibility-only-on-the-parent">Visibility only on the parent</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#create-delete-objects">Create - delete objects</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/object.html#screen-the-most-basic-parent">Screen – the most basic parent</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/layer.html">Layers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#order-of-creation">Order of creation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#bring-to-the-foreground">Bring to the foreground</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/layer.html#top-and-sys-layers">Top and sys layers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/event.html">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#event-types">Event types</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#generic-events">Generic events</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/event.html#special-events">Special events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#custom-data">Custom data</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/event.html#send-events-manually">Send events manually</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/style.html">Styles</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#use-the-styles">Use the styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#inherit-styles">Inherit styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#style-properties">Style properties</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#common-properties">Common properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#body-style-properties">Body style properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#text-style-properties">Text style properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#image-style-properties">Image style properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#line-style-properties">Line style properties</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#built-in-styles">Built-in styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#create-new-styles">Create new styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#style-animations">Style animations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#style-example">Style example</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/style.html#themes">Themes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/style.html#live-update">Live update</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/indev.html">Input devices</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#pointers">Pointers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#keypad-and-encoder">Keypad and encoder</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#groups">Groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#complete-example">Complete example</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/indev.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#input-device">Input device</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/indev.html#id1">Groups</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/display.html">Displays</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#using-only-one-display">Using only one display</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#mirror-display">Mirror display</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#split-image">Split image</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#screens">Screens</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#opaque-screen">Opaque screen</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#features-of-displays">Features of displays</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#inactivity">Inactivity</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#colors">Colors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#convert-color">Convert color</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#swap-16-colors">Swap 16 colors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#create-and-mix-colors">Create and mix colors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#opacity">Opacity</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#built-in-colors">Built-in colors</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/display.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#display">Display</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/display.html#id1">Colors</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/font.html">Fonts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#unicode-support">Unicode support</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#built-in-fonts">Built-in fonts</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#special-features">Special features</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#bidirectional-support">Bidirectional support</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#subpixel-rendering">Subpixel rendering</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/font.html#compress-fonts">Compress fonts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-new-font">Add new font</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-new-symbols">Add new symbols</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/font.html#add-a-new-font-engine">Add a new font engine</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/image.html">Images</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#store-images">Store images</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#variables">Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#files">Files</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#color-formats">Color formats</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#add-and-use-images">Add and use images</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#online-converter">Online converter</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#manually-create-an-image">Manually create an image</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#use-images">Use images</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#image-decoder">Image decoder</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#custom-image-formats">Custom image formats</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#register-an-image-decoder">Register an image decoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#manually-use-an-image-decoder">Manually use an image decoder</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#image-caching">Image caching</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#cache-size">Cache size</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#value-of-images">Value of images</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#memory-usage">Memory usage</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#clean-the-cache">Clean the cache</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/image.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#id1">Image decoder</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/image.html#image-cache">Image cache</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/file-system.html">File system</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#add-a-driver">Add a driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#usage-example">Usage example</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#use-drivers-for-images">Use drivers for images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/file-system.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/animation.html">Animations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#create-an-animation">Create an animation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#animation-path">Animation path</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#speed-vs-time">Speed vs time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#delete-animations">Delete animations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/animation.html#api">API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/animation.html#input-device">Input device</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/task.html">Tasks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#create-a-task">Create a task</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#ready-and-reset">Ready and Reset</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#set-parameters">Set parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#one-shot-tasks">One-shot tasks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#measure-idle-time">Measure idle time</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#asynchronous-calls">Asynchronous calls</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/task.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../overview/drawing.html">Drawing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#buffering-types">Buffering types</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/drawing.html#mechanism-of-screen-refreshing">Mechanism of screen refreshing</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Object types (Widgets)</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="obj.html">Base object (lv_obj)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="obj.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#coordinates">Coordinates</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#parents-and-children">Parents and children</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#screens">Screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#layers">Layers</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#style">Style</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#events">Events</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#attributes">Attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#opa-scale">Opa scale</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#protect">Protect</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#groups">Groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#extended-click-area">Extended click area</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#id1">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="obj.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="obj.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="obj.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="arc.html">Arc (lv_arc)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="arc.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="arc.html#angles">Angles</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="arc.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="arc.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arc.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bar.html">Bar (lv_bar)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bar.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bar.html#value-and-range">Value and range</a></li>
<li class="toctree-l4"><a class="reference internal" href="bar.html#symmetrical">Symmetrical</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bar.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="bar.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bar.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Button (lv_btn)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="#toggle">Toggle</a></li>
<li class="toctree-l4"><a class="reference internal" href="#layout-and-fit">Layout and Fit</a></li>
<li class="toctree-l4"><a class="reference internal" href="#ink-effect">Ink effect</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="btnm.html">Button matrix (lv_btnm)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="btnm.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#button-s-text">Button’s text</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#control-buttons">Control buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#one-toggle">One toggle</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#recolor">Recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btnm.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnm.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnm.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="btnm.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="btnm.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="btnm.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar (lv_calendar)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#current-date">Current date</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#shown-date">Shown date</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#highlighted-days">Highlighted days</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#name-of-the-days">Name of the days</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#name-of-the-months">Name of the months</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="calendar.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="calendar.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="canvas.html">Canvas (lv_canvas)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#buffer">Buffer</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#palette">Palette</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#drawing">Drawing</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#rotate">Rotate</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="canvas.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="canvas.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cb.html">Checkbox (lv_cb)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cb.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cb.html#text">Text</a></li>
<li class="toctree-l4"><a class="reference internal" href="cb.html#check-uncheck">Check/Uncheck</a></li>
<li class="toctree-l4"><a class="reference internal" href="cb.html#inactive">Inactive</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cb.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cb.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cb.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cb.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cb.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="cb.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cb.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="chart.html">Chart (lv_chart)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="chart.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="chart.html#data-series">Data series</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#series-type">Series’ type</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#modify-the-data">Modify the data</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#update-modes">Update modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#number-of-points">Number of points</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#vertical-range">Vertical range</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#division-lines">Division lines</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#series-appearance">Series’ appearance</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#tick-marks-and-labels">Tick marks and labels</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="chart.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="chart.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="chart.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cont.html">Container (lv_cont)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cont.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cont.html#layout">Layout</a></li>
<li class="toctree-l4"><a class="reference internal" href="cont.html#autofit">Autofit</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cont.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="cont.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cont.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpicker.html">Color picker (lv_cpicker)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#types-of-color-pickers">Types of color pickers</a></li>
<li class="toctree-l4"><a class="reference internal" href="cpicker.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#example">Example</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpicker.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="ddlist.html">Drop-down list (lv_ddlist)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="ddlist.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#set-options">Set options</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#get-selected-option">Get selected option</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#align-the-options">Align the options</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#height-and-width">Height and width</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#decoration-arrow">Decoration arrow</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#manually-open-close">Manually open/close</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#stay-open">Stay open</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ddlist.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="ddlist.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="ddlist.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="ddlist.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="ddlist.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ddlist.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gauge.html">Gauge (lv_gauge)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#scale">Scale</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#needles">Needles</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#range">Range</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#critical-value">Critical value</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="gauge.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gauge.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="img.html">Image (lv_img)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="img.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="img.html#image-source">Image source</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#label-as-an-image">Label as an image</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#transparency">Transparency</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#palette-and-alpha-index">Palette and Alpha index</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#recolor">Recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#auto-size">Auto-size</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#mosaic">Mosaic</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#offset">Offset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="img.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="img.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="img.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="img.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="img.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="imgbtn.html">Image button (lv_imgbtn)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#image-sources">Image sources</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#states">States</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#toggle">Toggle</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#style-usage">Style usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="imgbtn.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="imgbtn.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="kb.html">Keyboard (lv_kb)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="kb.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="kb.html#modes">Modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="kb.html#assign-text-area">Assign Text area</a></li>
<li class="toctree-l4"><a class="reference internal" href="kb.html#new-keymap">New Keymap</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="kb.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="kb.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="kb.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="kb.html#examples">Examples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="kb.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="kb.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="kb.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="label.html">Label (lv_label)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="label.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="label.html#set-text">Set text</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#line-break">Line break</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#long-modes">Long modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#text-align">Text align</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#draw-background">Draw background</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#text-recolor">Text recolor</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#very-long-texts">Very long texts</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#symbols">Symbols</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="label.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="label.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="label.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="label.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="label.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="led.html">LED (lv_led)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="led.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="led.html#brightness">Brightness</a></li>
<li class="toctree-l4"><a class="reference internal" href="led.html#toggle">Toggle</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="led.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="led.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="led.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="led.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="led.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="line.html">Line (lv_line)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="line.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="line.html#set-points">Set points</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#auto-size">Auto-size</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#invert-y">Invert y</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="line.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="line.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="line.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="line.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="line.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="list.html">List (lv_list)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="list.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="list.html#add-buttons">Add buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#delete-buttons">Delete buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#manual-navigation">Manual navigation</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#layout">Layout</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#edge-flash">Edge flash</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#scroll-propagation">Scroll propagation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="list.html#style-usage">Style usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="list.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="list.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="list.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="list.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lmeter.html">Line meter (lv_lmeter)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="lmeter.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="lmeter.html#set-value">Set value</a></li>
<li class="toctree-l4"><a class="reference internal" href="lmeter.html#range-and-angles">Range and Angles</a></li>
<li class="toctree-l4"><a class="reference internal" href="lmeter.html#angle-offset">Angle offset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="lmeter.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="lmeter.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="lmeter.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="lmeter.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="lmeter.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="lmeter.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="lmeter.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mbox.html">Message box (lv_mbox)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mbox.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="mbox.html#set-text">Set text</a></li>
<li class="toctree-l4"><a class="reference internal" href="mbox.html#add-buttons">Add buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="mbox.html#auto-close">Auto-close</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="mbox.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="mbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="mbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="mbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="mbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="mbox.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="page.html">Page (lv_page)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="page.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#glue-object">Glue object</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#focus-object">Focus object</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#manual-navigation">Manual navigation</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#edge-flash">Edge flash</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#scroll-propagation">Scroll propagation</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#scrollable-api">Scrollable API</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#notes">Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="page.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="page.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="page.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="page.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="preload.html">Preloader (lv_preload)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="preload.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="preload.html#arc-length">Arc length</a></li>
<li class="toctree-l4"><a class="reference internal" href="preload.html#spinning-speed">Spinning speed</a></li>
<li class="toctree-l4"><a class="reference internal" href="preload.html#spin-types">Spin types</a></li>
<li class="toctree-l4"><a class="reference internal" href="preload.html#spin-direction">Spin direction</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="preload.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="preload.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="preload.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="preload.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="preload.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="preload.html#id1">MicroPython</a></li>
<li class="toctree-l4"><a class="reference internal" href="preload.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="preload.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="roller.html">Roller (lv_roller)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="roller.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="roller.html#set-options">Set options</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#get-selected-option">Get selected option</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#align-the-options">Align the options</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#height-and-width">Height and width</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="roller.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="roller.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="roller.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="slider.html">Slider (lv_slider)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="slider.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#value-and-range">Value and range</a><ul>
<li class="toctree-l4"><a class="reference internal" href="slider.html#symmetrical">Symmetrical</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#knob-placement">Knob placement</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="slider.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="slider.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="slider.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spinbox.html">Spinbox (lv_spinbox)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#set-format">Set format</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#value-and-ranges">Value and ranges</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#style-usage">Style usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="spinbox.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#api">API</a></li>
<li class="toctree-l3"><a class="reference internal" href="spinbox.html#id1">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sw.html">Switch (lv_sw)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sw.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sw.html#change-state">Change state</a></li>
<li class="toctree-l4"><a class="reference internal" href="sw.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sw.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="sw.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="sw.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="sw.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sw.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="sw.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sw.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="table.html">Table (lv_table)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="table.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="table.html#rows-and-columns">Rows and Columns</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#width-and-height">Width and Height</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#set-cell-value">Set cell value</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#align">Align</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#cell-type">Cell type</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#merge-cells">Merge cells</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#crop-text">Crop text</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#scroll">Scroll</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="table.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="table.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#id1">MicroPython</a></li>
<li class="toctree-l4"><a class="reference internal" href="table.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="table.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tabview.html">Tabview (lv_tabview)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#adding-tab">Adding tab</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#change-tab">Change tab</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#tab-button-s-position">Tab button’s position</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#hide-the-tabs">Hide the tabs</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#animation-time">Animation time</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#style-usage">Style usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="tabview.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tabview.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="ta.html">Text area (lv_ta)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="ta.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ta.html#add-text">Add text</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#placeholder">Placeholder</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#delete-character">Delete character</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#move-the-cursor">Move the cursor</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#cursor-types">Cursor types</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#one-line-mode">One line mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#password-mode">Password mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#text-align">Text align</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#accepted-characters">Accepted characters</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#max-text-length">Max text length</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#very-long-texts">Very long texts</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#select-text">Select text</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#scroll-propagation">Scroll propagation</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#edge-flash">Edge flash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ta.html#style-usage">Style usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="ta.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="ta.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="ta.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="ta.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="ta.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ta.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tileview.html">Tile view (lv_tileview)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#valid-positions">Valid positions</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#add-element">Add element</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#set-tile">Set tile</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#animation-time">Animation time</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#edge-flash">Edge flash</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#styles">Styles</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="tileview.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tileview.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="win.html">Window (lv_win)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="win.html#overview">Overview</a><ul>
<li class="toctree-l4"><a class="reference internal" href="win.html#title">Title</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#control-buttons">Control buttons</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#scrollbars">Scrollbars</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#manual-scroll-and-focus">Manual scroll and focus</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#layout">Layout</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="win.html#style-usage">Style usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#events">Events</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#keys">Keys</a></li>
<li class="toctree-l3"><a class="reference internal" href="win.html#example">Example</a><ul>
<li class="toctree-l4"><a class="reference internal" href="win.html#c">C</a></li>
<li class="toctree-l4"><a class="reference internal" href="win.html#micropython">MicroPython</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="win.html#api">API</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">LittlevGL</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="index.html">Object types (Widgets)</a> &raquo;</li>
        
      <li>Button (lv_btn)</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            
              <!-- User defined GitHub URL -->
              <a href="https://github.com/littlevgl/docs/blob/master/en/object-types/btn.md" class="fa fa-github"> Edit on GitHub</a>
            
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="button-lv-btn">
<h1>Button (lv_btn)<a class="headerlink" href="#button-lv-btn" title="Permalink to this headline">¶</a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>Buttons are simple rectangle-like objects, but they change their style and state when they are pressed or released.</p>
<div class="section" id="states">
<h3>States<a class="headerlink" href="#states" title="Permalink to this headline">¶</a></h3>
<p>Buttons can be in one of the 5 possible states:</p>
<ul class="simple">
<li><p><strong>LV_BTN_STATE_REL</strong> - Released state</p></li>
<li><p><strong>LV_BTN_STATE_PR</strong> - Pressed state</p></li>
<li><p><strong>LV_BTN_STATE_TGL_REL</strong> - Toggled released state</p></li>
<li><p><strong>LV_BTN_STATE_TGL_PR</strong> - Toggled pressed state</p></li>
<li><p><strong>LV_BTN_STATE_INA</strong> - Inactive state</p></li>
</ul>
<p>The state from <code class="docutils literal notranslate"><span class="pre">..._REL</span></code> to <code class="docutils literal notranslate"><span class="pre">..._PR</span></code> will be changed automatically when the button is pressed or released.</p>
<p>You can set the button’s state manually with <code class="docutils literal notranslate"><span class="pre">lv_btn_set_state(btn,</span> <span class="pre">LV_BTN_STATE_TGL_REL)</span></code>.</p>
</div>
<div class="section" id="toggle">
<h3>Toggle<a class="headerlink" href="#toggle" title="Permalink to this headline">¶</a></h3>
<p>You can configure the buttons as <em>toggle button</em> with <code class="docutils literal notranslate"><span class="pre">lv_btn_set_toggle(btn,</span> <span class="pre">true)</span></code>. In this case, on release, the button goes to <em>toggled released</em> state.</p>
</div>
<div class="section" id="layout-and-fit">
<h3>Layout and Fit<a class="headerlink" href="#layout-and-fit" title="Permalink to this headline">¶</a></h3>
<p>Similarly to <a class="reference internal" href="cont.html"><span class="doc">Containers</span></a>, buttons also have layout and fit attributes.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_layout(btn,</span> <span class="pre">LV_LAYOUT_...)</span> </code>set a layout. The default is <code class="docutils literal notranslate"><span class="pre">LV_LAYOUT_CENTER</span></code>.
So, if you add a label, then it will be automatically aligned to the middle and can’t be moved with <code class="docutils literal notranslate"><span class="pre">lv_obj_set_pos()</span></code>.
You can disable the layout with <code class="docutils literal notranslate"><span class="pre">lv_btn_set_layout(btn,</span> <span class="pre">LV_LAYOUT_OFF)</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_fit/fit2/fit4(btn,</span> <span class="pre">LV_FIT_..)</span></code> enables to set the button width and/or height automatically according to the children, parent, and fit type.</p></li>
</ul>
</div>
<div class="section" id="ink-effect">
<h3>Ink effect<a class="headerlink" href="#ink-effect" title="Permalink to this headline">¶</a></h3>
<p>You can enable a special animation on buttons: when a button is pressed, the pressed state will be drawn in a growing circle starting from the point of pressing. It’s similar in appearance and functionality to the Material Design ripple effect.</p>
<p>Another way to think about it is like an ink droplet dropped into water. When the button is released, the released state will be reverted by fading. It’s like the ink is fully mixed with a lot of water and becomes invisible.</p>
<p>To control this animation, use the following functions:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_ink_in_time(btn,</span> <span class="pre">time_ms)</span></code> - time of circle growing.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_ink_wait_time(btn,</span> <span class="pre">time_ms)</span></code> - minim time to keep the fully covering (pressed) state.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">lv_btn_set_ink_out_time(btn,</span> <span class="pre">time_ms)</span></code> - time fade back to releases state.</p></li>
</ul>
<p>This feature needs to be enabled with <code class="docutils literal notranslate"><span class="pre">LV_BTN_INK_EFFECT</span>&#160; <span class="pre">1</span></code> in <em>lv_conf.h</em>.</p>
</div>
</div>
<div class="section" id="styles">
<h2>Styles<a class="headerlink" href="#styles" title="Permalink to this headline">¶</a></h2>
<p>A button can have 5 independent styles for the 5 states. You can set them via: <code class="docutils literal notranslate"><span class="pre">lv_btn_set_style(btn,</span> <span class="pre">LV_BTN_STYLE_...,</span> <span class="pre">&amp;style)</span></code>. The styles use the <code class="docutils literal notranslate"><span class="pre">style.body</span></code> properties.</p>
<ul class="simple">
<li><p><strong>LV_BTN_STYLE_REL</strong> - style of the released state. Default: <code class="docutils literal notranslate"><span class="pre">lv_style_btn_rel</span></code>.</p></li>
<li><p><strong>LV_BTN_STYLE_PR</strong> - style of the pressed state. Default: <code class="docutils literal notranslate"><span class="pre">lv_style_btn_pr</span></code>.</p></li>
<li><p><strong>LV_BTN_STYLE_TGL_REL</strong> - style of the toggled released state. Default: <code class="docutils literal notranslate"><span class="pre">lv_style_btn_tgl_rel</span></code>.</p></li>
<li><p><strong>LV_BTN_STYLE_TGL_PR</strong> - style of the toggled pressed state. Default: <code class="docutils literal notranslate"><span class="pre">lv_style_btn_tgl_pr</span></code>.</p></li>
<li><p><strong>LV_BTN_STYLE_INA</strong> - style of the inactive state. Default: <code class="docutils literal notranslate"><span class="pre">lv_style_btn_ina</span></code>.</p></li>
</ul>
<p>When you create a label on a button, it’s a good practice to set the button’s <code class="docutils literal notranslate"><span class="pre">style.text</span></code> properties too. Because labels have <code class="docutils literal notranslate"><span class="pre">style</span> <span class="pre">=</span> <span class="pre">NULL</span></code> by default, they inherit the parent’s (button) style.
Hence you don’t need to create a new style for the label.</p>
</div>
<div class="section" id="events">
<h2>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h2>
<p>Besides the <a class="reference external" href="/overview/event.html#generic-events">Generic events</a> the following <a class="reference external" href="/overview/event.html#special-events">Special events</a> are sent by the buttons:</p>
<ul class="simple">
<li><p><strong>LV_EVENT_VALUE_CHANGED</strong> - sent when the button is toggled.</p></li>
</ul>
<p>Note that, the generic input device-related events (like <code class="docutils literal notranslate"><span class="pre">LV_EVENT_PRESSED</span></code>) are sent in the inactive state too. You need to check the state with <code class="docutils literal notranslate"><span class="pre">lv_btn_get_state(btn)</span></code> to ignore the events from inactive buttons.</p>
<p>Learn more about <a class="reference internal" href="../overview/event.html"><span class="doc">Events</span></a>.</p>
</div>
<div class="section" id="keys">
<h2>Keys<a class="headerlink" href="#keys" title="Permalink to this headline">¶</a></h2>
<p>The following <em>Keys</em> are processed by the Buttons:</p>
<ul class="simple">
<li><p><strong>LV_KEY_RIGHT/UP</strong> - Go to toggled state if toggling is enabled.</p></li>
<li><p><strong>LV_KEY_LEFT/DOWN</strong> - Go to non-toggled state if toggling is enabled.</p></li>
</ul>
<p>Note that, by default, the state of <code class="docutils literal notranslate"><span class="pre">LV_KEY_ENTER</span></code> is translated to <code class="docutils literal notranslate"><span class="pre">LV_EVENT_PRESSED/PRESSING/RELEASED</span></code> etc.</p>
<p>Learn more about <a class="reference internal" href="../overview/indev.html"><span class="doc">Keys</span></a>.</p>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<div class="section" id="c">
<h3>C<a class="headerlink" href="#c" title="Permalink to this headline">¶</a></h3>
<div class="section" id="simple-buttons">
<h4>Simple Buttons<a class="headerlink" href="#simple-buttons" title="Permalink to this headline">¶</a></h4>
<img alt="Simple Button example in LittlevGL" src="../_images/lv_ex_btn_1.gif" />
<div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf">&quot;lvgl/lvgl.h&quot;</span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf">&lt;stdio.h&gt;</span><span class="cp"></span>

<span class="k">static</span> <span class="kt">void</span> <span class="nf">event_handler</span><span class="p">(</span><span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">obj</span><span class="p">,</span> <span class="n">lv_event_t</span> <span class="n">event</span><span class="p">)</span>
<span class="p">{</span>
    <span class="k">if</span><span class="p">(</span><span class="n">event</span> <span class="o">==</span> <span class="n">LV_EVENT_CLICKED</span><span class="p">)</span> <span class="p">{</span>
        <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Clicked</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
    <span class="p">}</span>
    <span class="k">else</span> <span class="k">if</span><span class="p">(</span><span class="n">event</span> <span class="o">==</span> <span class="n">LV_EVENT_VALUE_CHANGED</span><span class="p">)</span> <span class="p">{</span>
        <span class="n">printf</span><span class="p">(</span><span class="s">&quot;Toggled</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
    <span class="p">}</span>
<span class="p">}</span>

<span class="kt">void</span> <span class="nf">lv_ex_btn_1</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">label</span><span class="p">;</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn1</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_event_cb</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="n">event_handler</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">40</span><span class="p">);</span>

    <span class="n">label</span> <span class="o">=</span> <span class="n">lv_label_create</span><span class="p">(</span><span class="n">btn1</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_label_set_text</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="s">&quot;Button&quot;</span><span class="p">);</span>

    <span class="n">lv_obj_t</span> <span class="o">*</span> <span class="n">btn2</span> <span class="o">=</span> <span class="n">lv_btn_create</span><span class="p">(</span><span class="n">lv_scr_act</span><span class="p">(),</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_obj_set_event_cb</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="n">event_handler</span><span class="p">);</span>
    <span class="n">lv_obj_align</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="n">LV_ALIGN_CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">40</span><span class="p">);</span>
    <span class="n">lv_btn_set_toggle</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">true</span><span class="p">);</span>
    <span class="n">lv_btn_toggle</span><span class="p">(</span><span class="n">btn2</span><span class="p">);</span>
    <span class="n">lv_btn_set_fit2</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="n">LV_FIT_NONE</span><span class="p">,</span> <span class="n">LV_FIT_TIGHT</span><span class="p">);</span>

    <span class="n">label</span> <span class="o">=</span> <span class="n">lv_label_create</span><span class="p">(</span><span class="n">btn2</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
    <span class="n">lv_label_set_text</span><span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="s">&quot;Toggled&quot;</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="micropython">
<h3>MicroPython<a class="headerlink" href="#micropython" title="Permalink to this headline">¶</a></h3>
<div class="section" id="id1">
<h4>Simple Buttons<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<img alt="Simple Button example in LittlevGL with MicroPython" src="../_images/lv_ex_btn_1.gif" />
<div class="toggle docutils container">
<div class="header docutils container">
<p>code</p>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">event_handler</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
    <span class="k">if</span> <span class="n">event</span> <span class="o">==</span> <span class="n">lv</span><span class="o">.</span><span class="n">EVENT</span><span class="o">.</span><span class="n">CLICKED</span><span class="p">:</span>
        <span class="k">print</span><span class="p">(</span><span class="s2">&quot;Clicked&quot;</span><span class="p">)</span>

<span class="n">btn1</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">())</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">set_event_cb</span><span class="p">(</span><span class="n">event_handler</span><span class="p">)</span>
<span class="n">btn1</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">40</span><span class="p">)</span>

<span class="n">label</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">btn1</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="s2">&quot;Button&quot;</span><span class="p">)</span>

<span class="n">btn2</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">btn</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">scr_act</span><span class="p">())</span>
<span class="c1"># callback can be lambda:</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">set_event_cb</span><span class="p">(</span><span class="k">lambda</span> <span class="n">obj</span><span class="p">,</span> <span class="n">event</span><span class="p">:</span> <span class="k">print</span><span class="p">(</span><span class="s2">&quot;Toggled&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">event</span> <span class="o">==</span> <span class="n">lv</span><span class="o">.</span><span class="n">EVENT</span><span class="o">.</span><span class="n">VALUE_CHANGED</span> <span class="k">else</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">align</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">ALIGN</span><span class="o">.</span><span class="n">CENTER</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">40</span><span class="p">)</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">set_toggle</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">toggle</span><span class="p">()</span>
<span class="n">btn2</span><span class="o">.</span><span class="n">set_fit2</span><span class="p">(</span><span class="n">lv</span><span class="o">.</span><span class="n">FIT</span><span class="o">.</span><span class="n">NONE</span><span class="p">,</span> <span class="n">lv</span><span class="o">.</span><span class="n">FIT</span><span class="o">.</span><span class="n">TIGHT</span><span class="p">)</span>

<span class="n">label</span> <span class="o">=</span> <span class="n">lv</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">btn2</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="s2">&quot;Toggled&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Typedefs</p>
<dl class="cpp type">
<dt id="_CPPv414lv_btn_state_t">
<span id="_CPPv314lv_btn_state_t"></span><span id="_CPPv214lv_btn_state_t"></span><span id="lv_btn_state_t"></span><span class="target" id="lv__btn_8h_1ad76298e1d7b3cb0e8491be29483c7e8d"></span><em class="property">typedef </em>uint8_t <code class="sig-name descname">lv_btn_state_t</code><a class="headerlink" href="#_CPPv414lv_btn_state_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp type">
<dt id="_CPPv414lv_btn_style_t">
<span id="_CPPv314lv_btn_style_t"></span><span id="_CPPv214lv_btn_style_t"></span><span id="lv_btn_style_t"></span><span class="target" id="lv__btn_8h_1aef760ffb7cde590462e2a0ddfa516a2d"></span><em class="property">typedef </em>uint8_t <code class="sig-name descname">lv_btn_style_t</code><a class="headerlink" href="#_CPPv414lv_btn_style_t" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Enums</p>
<dl class="cpp enum">
<dt id="_CPPv4Ut2_42">
<span id="_CPPv3Ut2_42"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5f"></span><em class="property">enum </em><strong>[anonymous]</strong><a class="headerlink" href="#_CPPv4Ut2_42" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Possible states of a button. It can be used not only by buttons but other button-like objects too </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4216LV_BTN_STATE_RELE">
<span id="_CPPv3NUt2_4216LV_BTN_STATE_RELE"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5fa6fe7d0628fd83978723243f25c328698"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STATE_REL</code><a class="headerlink" href="#_CPPv4NUt2_4216LV_BTN_STATE_RELE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Released </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4215LV_BTN_STATE_PRE">
<span id="_CPPv3NUt2_4215LV_BTN_STATE_PRE"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5fa95120fbe1aed0ce2afe8808fd1f71503"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STATE_PR</code><a class="headerlink" href="#_CPPv4NUt2_4215LV_BTN_STATE_PRE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Pressed </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4220LV_BTN_STATE_TGL_RELE">
<span id="_CPPv3NUt2_4220LV_BTN_STATE_TGL_RELE"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5fad97b0aa9edf4ca8b2d73e7af492eb73f"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STATE_TGL_REL</code><a class="headerlink" href="#_CPPv4NUt2_4220LV_BTN_STATE_TGL_RELE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggled released </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4219LV_BTN_STATE_TGL_PRE">
<span id="_CPPv3NUt2_4219LV_BTN_STATE_TGL_PRE"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5facf610552d0c8f2a7c7f1ffe00dd809f1"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STATE_TGL_PR</code><a class="headerlink" href="#_CPPv4NUt2_4219LV_BTN_STATE_TGL_PRE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggled pressed </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4216LV_BTN_STATE_INAE">
<span id="_CPPv3NUt2_4216LV_BTN_STATE_INAE"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5fa76180283e9d839542d8afdd722534e77"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STATE_INA</code><a class="headerlink" href="#_CPPv4NUt2_4216LV_BTN_STATE_INAE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Inactive </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4217_LV_BTN_STATE_NUME">
<span id="_CPPv3NUt2_4217_LV_BTN_STATE_NUME"></span><span class="target" id="lv__btn_8h_1a394b3903fbf00ba2b6243f60689a5a5fa4d396481bfaf752063614d99d3d0dca9"></span><em class="property">enumerator </em><code class="sig-name descname">_LV_BTN_STATE_NUM</code><a class="headerlink" href="#_CPPv4NUt2_4217_LV_BTN_STATE_NUME" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Number of states </p>
</dd></dl>

</dd></dl>

<dl class="cpp enum">
<dt id="_CPPv4Ut2_43">
<span id="_CPPv3Ut2_43"></span><span class="target" id="lv__btn_8h_1ac205be2172292384dd687b5471a87edd"></span><em class="property">enum </em><strong>[anonymous]</strong><a class="headerlink" href="#_CPPv4Ut2_43" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Styles </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4316LV_BTN_STYLE_RELE">
<span id="_CPPv3NUt2_4316LV_BTN_STYLE_RELE"></span><span class="target" id="lv__btn_8h_1ac205be2172292384dd687b5471a87edda8c3ed952363326382d5a06843c32ab1c"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STYLE_REL</code><a class="headerlink" href="#_CPPv4NUt2_4316LV_BTN_STYLE_RELE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Release style </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4315LV_BTN_STYLE_PRE">
<span id="_CPPv3NUt2_4315LV_BTN_STYLE_PRE"></span><span class="target" id="lv__btn_8h_1ac205be2172292384dd687b5471a87eddaf9ff7159d21032adaa94cef70e23a5ab"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STYLE_PR</code><a class="headerlink" href="#_CPPv4NUt2_4315LV_BTN_STYLE_PRE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Pressed style </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4320LV_BTN_STYLE_TGL_RELE">
<span id="_CPPv3NUt2_4320LV_BTN_STYLE_TGL_RELE"></span><span class="target" id="lv__btn_8h_1ac205be2172292384dd687b5471a87eddaf1d05e2cd81d8711b8d480dc622a443a"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STYLE_TGL_REL</code><a class="headerlink" href="#_CPPv4NUt2_4320LV_BTN_STYLE_TGL_RELE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggle released style </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4319LV_BTN_STYLE_TGL_PRE">
<span id="_CPPv3NUt2_4319LV_BTN_STYLE_TGL_PRE"></span><span class="target" id="lv__btn_8h_1ac205be2172292384dd687b5471a87edda30890530147d41c193e7119a504feea0"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STYLE_TGL_PR</code><a class="headerlink" href="#_CPPv4NUt2_4319LV_BTN_STYLE_TGL_PRE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggle pressed style </p>
</dd></dl>

<dl class="cpp enumerator">
<dt id="_CPPv4NUt2_4316LV_BTN_STYLE_INAE">
<span id="_CPPv3NUt2_4316LV_BTN_STYLE_INAE"></span><span class="target" id="lv__btn_8h_1ac205be2172292384dd687b5471a87edda0343e2f21ba9c1144bf011fb14ba65fc"></span><em class="property">enumerator </em><code class="sig-name descname">LV_BTN_STYLE_INA</code><a class="headerlink" href="#_CPPv4NUt2_4316LV_BTN_STYLE_INAE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Inactive style </p>
</dd></dl>

</dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Functions</p>
<dl class="cpp function">
<dt id="_CPPv413lv_btn_createP8lv_obj_tPK8lv_obj_t">
<span id="_CPPv313lv_btn_createP8lv_obj_tPK8lv_obj_t"></span><span id="_CPPv213lv_btn_createP8lv_obj_tPK8lv_obj_t"></span><span id="lv_btn_create__lv_obj_tP.lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a9019f4e861e31cd369b433b9d2a2fc0c"></span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<code class="sig-name descname">lv_btn_create</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>par</em>, <em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>copy</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413lv_btn_createP8lv_obj_tPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Create a button object <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>pointer to the created button </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">par</span></code>: pointer to an object, it will be the parent of the new button </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">copy</span></code>: pointer to a button object, if not NULL then the new object will be copied from it </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv417lv_btn_set_toggleP8lv_obj_tb">
<span id="_CPPv317lv_btn_set_toggleP8lv_obj_tb"></span><span id="_CPPv217lv_btn_set_toggleP8lv_obj_tb"></span><span id="lv_btn_set_toggle__lv_obj_tP.b"></span><span class="target" id="lv__btn_8h_1ad7515c0889dc6c1658b88d4319fef67b"></span>void <code class="sig-name descname">lv_btn_set_toggle</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, bool <em>tgl</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_btn_set_toggleP8lv_obj_tb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Enable the toggled states. On release the button will change from/to toggled state. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tgl</span></code>: true: enable toggled states, false: disable </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv416lv_btn_set_stateP8lv_obj_t14lv_btn_state_t">
<span id="_CPPv316lv_btn_set_stateP8lv_obj_t14lv_btn_state_t"></span><span id="_CPPv216lv_btn_set_stateP8lv_obj_t14lv_btn_state_t"></span><span id="lv_btn_set_state__lv_obj_tP.lv_btn_state_t"></span><span class="target" id="lv__btn_8h_1ac9f0f3f344ff91e547491c93293ac591"></span>void <code class="sig-name descname">lv_btn_set_state</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="#_CPPv414lv_btn_state_t" title="lv_btn_state_t">lv_btn_state_t</a> <em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_btn_set_stateP8lv_obj_t14lv_btn_state_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the state of the button <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">state</span></code>: the new state of the button (from lv_btn_state_t enum) </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv413lv_btn_toggleP8lv_obj_t">
<span id="_CPPv313lv_btn_toggleP8lv_obj_t"></span><span id="_CPPv213lv_btn_toggleP8lv_obj_t"></span><span id="lv_btn_toggle__lv_obj_tP"></span><span class="target" id="lv__btn_8h_1a906c44ebe25f1d8a6edbb528b03b5c89"></span>void <code class="sig-name descname">lv_btn_toggle</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413lv_btn_toggleP8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggle the state of the button (ON-&gt;OFF, OFF-&gt;ON) <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv417lv_btn_set_layoutP8lv_obj_t11lv_layout_t">
<span id="_CPPv317lv_btn_set_layoutP8lv_obj_t11lv_layout_t"></span><span id="_CPPv217lv_btn_set_layoutP8lv_obj_t11lv_layout_t"></span><span id="lv_btn_set_layout__lv_obj_tP.lv_layout_t"></span><span class="target" id="lv__btn_8h_1af889fd9cc4cac8e4224321a106ba2f4d"></span>void <code class="sig-name descname">lv_btn_set_layout</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="cont.html#_CPPv411lv_layout_t" title="lv_layout_t">lv_layout_t</a> <em>layout</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_btn_set_layoutP8lv_obj_t11lv_layout_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the layout on a button <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">layout</span></code>: a layout from ‘lv_cont_layout_t’ </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv415lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t">
<span id="_CPPv315lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t"></span><span id="_CPPv215lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t"></span><span id="lv_btn_set_fit4__lv_obj_tP.lv_fit_t.lv_fit_t.lv_fit_t.lv_fit_t"></span><span class="target" id="lv__btn_8h_1aec9f3495266585a143f283d7effa518a"></span>void <code class="sig-name descname">lv_btn_set_fit4</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>left</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>right</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>top</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>bottom</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415lv_btn_set_fit4P8lv_obj_t8lv_fit_t8lv_fit_t8lv_fit_t8lv_fit_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the fit policy in all 4 directions separately. It tells how to change the button size automatically. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">left</span></code>: left fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">right</span></code>: right fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">top</span></code>: top fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bottom</span></code>: bottom fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv415lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t">
<span id="_CPPv315lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t"></span><span id="_CPPv215lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t"></span><span id="lv_btn_set_fit2__lv_obj_tP.lv_fit_t.lv_fit_t"></span><span class="target" id="lv__btn_8h_1a6b49c65cd0fb916015f5cd5d41058f85"></span>void <code class="sig-name descname">lv_btn_set_fit2</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>hor</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>ver</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415lv_btn_set_fit2P8lv_obj_t8lv_fit_t8lv_fit_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the fit policy horizontally and vertically separately. It tells how to change the button size automatically. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">hor</span></code>: horizontal fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ver</span></code>: vertical fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv414lv_btn_set_fitP8lv_obj_t8lv_fit_t">
<span id="_CPPv314lv_btn_set_fitP8lv_obj_t8lv_fit_t"></span><span id="_CPPv214lv_btn_set_fitP8lv_obj_t8lv_fit_t"></span><span id="lv_btn_set_fit__lv_obj_tP.lv_fit_t"></span><span class="target" id="lv__btn_8h_1abd07e9312fad15bfff86cdbd741b19aa"></span>void <code class="sig-name descname">lv_btn_set_fit</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <em>fit</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414lv_btn_set_fitP8lv_obj_t8lv_fit_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the fit policy in all 4 direction at once. It tells how to change the button size automatically. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fit</span></code>: fit policy from <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv422lv_btn_set_ink_in_timeP8lv_obj_t8uint16_t">
<span id="_CPPv322lv_btn_set_ink_in_timeP8lv_obj_t8uint16_t"></span><span id="_CPPv222lv_btn_set_ink_in_timeP8lv_obj_t8uint16_t"></span><span id="lv_btn_set_ink_in_time__lv_obj_tP.uint16_t"></span><span class="target" id="lv__btn_8h_1af7fa2f49940727aa0bb03d667071756f"></span>void <code class="sig-name descname">lv_btn_set_ink_in_time</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, uint16_t <em>time</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422lv_btn_set_ink_in_timeP8lv_obj_t8uint16_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set time of the ink effect (draw a circle on click to animate in the new state) <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">time</span></code>: the time of the ink animation </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv424lv_btn_set_ink_wait_timeP8lv_obj_t8uint16_t">
<span id="_CPPv324lv_btn_set_ink_wait_timeP8lv_obj_t8uint16_t"></span><span id="_CPPv224lv_btn_set_ink_wait_timeP8lv_obj_t8uint16_t"></span><span id="lv_btn_set_ink_wait_time__lv_obj_tP.uint16_t"></span><span class="target" id="lv__btn_8h_1ae450d6a9e090dc5fb8a60a9e1ccdc28b"></span>void <code class="sig-name descname">lv_btn_set_ink_wait_time</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, uint16_t <em>time</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424lv_btn_set_ink_wait_timeP8lv_obj_t8uint16_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the wait time before the ink disappears <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">time</span></code>: the time of the ink animation </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv423lv_btn_set_ink_out_timeP8lv_obj_t8uint16_t">
<span id="_CPPv323lv_btn_set_ink_out_timeP8lv_obj_t8uint16_t"></span><span id="_CPPv223lv_btn_set_ink_out_timeP8lv_obj_t8uint16_t"></span><span id="lv_btn_set_ink_out_time__lv_obj_tP.uint16_t"></span><span class="target" id="lv__btn_8h_1a7f4273f23b996fd75b8f5602c8bcc5a4"></span>void <code class="sig-name descname">lv_btn_set_ink_out_time</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, uint16_t <em>time</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423lv_btn_set_ink_out_timeP8lv_obj_t8uint16_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set time of the ink out effect (animate to the released state) <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">time</span></code>: the time of the ink animation </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv416lv_btn_set_styleP8lv_obj_t14lv_btn_style_tPK10lv_style_t">
<span id="_CPPv316lv_btn_set_styleP8lv_obj_t14lv_btn_style_tPK10lv_style_t"></span><span id="_CPPv216lv_btn_set_styleP8lv_obj_t14lv_btn_style_tPK10lv_style_t"></span><span id="lv_btn_set_style__lv_obj_tP.lv_btn_style_t.lv_style_tCP"></span><span class="target" id="lv__btn_8h_1ace4ffd390ea1ce294268b220e241d10a"></span>void <code class="sig-name descname">lv_btn_set_style</code><span class="sig-paren">(</span><a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="#_CPPv414lv_btn_style_t" title="lv_btn_style_t">lv_btn_style_t</a> <em>type</em>, <em class="property">const</em> lv_style_t *<em>style</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_btn_set_styleP8lv_obj_t14lv_btn_style_tPK10lv_style_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set a style of a button. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code>: which style should be set </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">style</span></code>: pointer to a style </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv416lv_btn_get_statePK8lv_obj_t">
<span id="_CPPv316lv_btn_get_statePK8lv_obj_t"></span><span id="_CPPv216lv_btn_get_statePK8lv_obj_t"></span><span id="lv_btn_get_state__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1ab2649a6b5c41f95269f3d8c93d34f441"></span><a class="reference internal" href="#_CPPv414lv_btn_state_t" title="lv_btn_state_t">lv_btn_state_t</a> <code class="sig-name descname">lv_btn_get_state</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_btn_get_statePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the current state of the button <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the state of the button (from lv_btn_state_t enum) </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv417lv_btn_get_togglePK8lv_obj_t">
<span id="_CPPv317lv_btn_get_togglePK8lv_obj_t"></span><span id="_CPPv217lv_btn_get_togglePK8lv_obj_t"></span><span id="lv_btn_get_toggle__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1acd0ec2a441c5d23e9b9baeceabf1010f"></span>bool <code class="sig-name descname">lv_btn_get_toggle</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_btn_get_togglePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the toggle enable attribute of the button <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true: toggle enabled, false: disabled </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv417lv_btn_get_layoutPK8lv_obj_t">
<span id="_CPPv317lv_btn_get_layoutPK8lv_obj_t"></span><span id="_CPPv217lv_btn_get_layoutPK8lv_obj_t"></span><span id="lv_btn_get_layout__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1ab701e50276c79f36e70b2447abea538a"></span><a class="reference internal" href="cont.html#_CPPv411lv_layout_t" title="lv_layout_t">lv_layout_t</a> <code class="sig-name descname">lv_btn_get_layout</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417lv_btn_get_layoutPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the layout of a button <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the layout from ‘lv_cont_layout_t’ </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv419lv_btn_get_fit_leftPK8lv_obj_t">
<span id="_CPPv319lv_btn_get_fit_leftPK8lv_obj_t"></span><span id="_CPPv219lv_btn_get_fit_leftPK8lv_obj_t"></span><span id="lv_btn_get_fit_left__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1aa627cd830b4890739094bda7be31a864"></span><a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <code class="sig-name descname">lv_btn_get_fit_left</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419lv_btn_get_fit_leftPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the left fit mode <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv420lv_btn_get_fit_rightPK8lv_obj_t">
<span id="_CPPv320lv_btn_get_fit_rightPK8lv_obj_t"></span><span id="_CPPv220lv_btn_get_fit_rightPK8lv_obj_t"></span><span id="lv_btn_get_fit_right__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1acb8d00c53aed23fbba1c1e13095d8f71"></span><a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <code class="sig-name descname">lv_btn_get_fit_right</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420lv_btn_get_fit_rightPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the right fit mode <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv418lv_btn_get_fit_topPK8lv_obj_t">
<span id="_CPPv318lv_btn_get_fit_topPK8lv_obj_t"></span><span id="_CPPv218lv_btn_get_fit_topPK8lv_obj_t"></span><span id="lv_btn_get_fit_top__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a9dd5acae9cabe814c279c82c78b9e1eb"></span><a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <code class="sig-name descname">lv_btn_get_fit_top</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418lv_btn_get_fit_topPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the top fit mode <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv421lv_btn_get_fit_bottomPK8lv_obj_t">
<span id="_CPPv321lv_btn_get_fit_bottomPK8lv_obj_t"></span><span id="_CPPv221lv_btn_get_fit_bottomPK8lv_obj_t"></span><span id="lv_btn_get_fit_bottom__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a049ef6780b716f82d921974fe14227e9"></span><a class="reference internal" href="cont.html#_CPPv48lv_fit_t" title="lv_fit_t">lv_fit_t</a> <code class="sig-name descname">lv_btn_get_fit_bottom</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421lv_btn_get_fit_bottomPK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the bottom fit mode <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>an element of <code class="docutils literal notranslate"><span class="pre">lv_fit_t</span></code> </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv422lv_btn_get_ink_in_timePK8lv_obj_t">
<span id="_CPPv322lv_btn_get_ink_in_timePK8lv_obj_t"></span><span id="_CPPv222lv_btn_get_ink_in_timePK8lv_obj_t"></span><span id="lv_btn_get_ink_in_time__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1add989326f393eab8880631d423730240"></span>uint16_t <code class="sig-name descname">lv_btn_get_ink_in_time</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422lv_btn_get_ink_in_timePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get time of the ink in effect (draw a circle on click to animate in the new state) <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the time of the ink animation </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv424lv_btn_get_ink_wait_timePK8lv_obj_t">
<span id="_CPPv324lv_btn_get_ink_wait_timePK8lv_obj_t"></span><span id="_CPPv224lv_btn_get_ink_wait_timePK8lv_obj_t"></span><span id="lv_btn_get_ink_wait_time__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1a855e2f009f9c5599f709ffdba60a4389"></span>uint16_t <code class="sig-name descname">lv_btn_get_ink_wait_time</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424lv_btn_get_ink_wait_timePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get the wait time before the ink disappears <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the time of the ink animation </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv423lv_btn_get_ink_out_timePK8lv_obj_t">
<span id="_CPPv323lv_btn_get_ink_out_timePK8lv_obj_t"></span><span id="_CPPv223lv_btn_get_ink_out_timePK8lv_obj_t"></span><span id="lv_btn_get_ink_out_time__lv_obj_tCP"></span><span class="target" id="lv__btn_8h_1af4ed4e7be615fa001164002eb55d1461"></span>uint16_t <code class="sig-name descname">lv_btn_get_ink_out_time</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423lv_btn_get_ink_out_timePK8lv_obj_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get time of the ink out effect (animate to the releases state) <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the time of the ink animation </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to a button object </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv416lv_btn_get_stylePK8lv_obj_t14lv_btn_style_t">
<span id="_CPPv316lv_btn_get_stylePK8lv_obj_t14lv_btn_style_t"></span><span id="_CPPv216lv_btn_get_stylePK8lv_obj_t14lv_btn_style_t"></span><span id="lv_btn_get_style__lv_obj_tCP.lv_btn_style_t"></span><span class="target" id="lv__btn_8h_1a0ffe58eb72810d1ca1cacaed6c4e47d2"></span><em class="property">const</em> lv_style_t *<code class="sig-name descname">lv_btn_get_style</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="obj.html#_CPPv48lv_obj_t" title="lv_obj_t">lv_obj_t</a> *<em>btn</em>, <a class="reference internal" href="#_CPPv414lv_btn_style_t" title="lv_btn_style_t">lv_btn_style_t</a> <em>type</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416lv_btn_get_stylePK8lv_obj_t14lv_btn_style_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Get style of a button. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>style pointer to the style </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">btn</span></code>: pointer to button object </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code>: which style should be get </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

</div>
<dl class="cpp struct">
<dt id="_CPPv412lv_btn_ext_t">
<span id="_CPPv312lv_btn_ext_t"></span><span id="_CPPv212lv_btn_ext_t"></span><span id="lv_btn_ext_t"></span><span class="target" id="structlv__btn__ext__t"></span><em class="property">struct </em><code class="sig-name descname">lv_btn_ext_t</code><a class="headerlink" href="#_CPPv412lv_btn_ext_t" title="Permalink to this definition">¶</a><br /></dt>
<dd><em>#include &lt;lv_btn.h&gt;</em><p>Extended data of button </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t4contE">
<span id="_CPPv3N12lv_btn_ext_t4contE"></span><span id="_CPPv2N12lv_btn_ext_t4contE"></span><span id="lv_btn_ext_t::cont__lv_cont_ext_t"></span><span class="target" id="structlv__btn__ext__t_1af1e27a69f6cadfc900f6ae47f2e8d33e"></span><a class="reference internal" href="cont.html#_CPPv413lv_cont_ext_t" title="lv_cont_ext_t">lv_cont_ext_t</a> <code class="sig-name descname">cont</code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t4contE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Ext. of ancestor </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t6stylesE">
<span id="_CPPv3N12lv_btn_ext_t6stylesE"></span><span id="_CPPv2N12lv_btn_ext_t6stylesE"></span><span id="lv_btn_ext_t::styles__lv_style_tCPA"></span><span class="target" id="structlv__btn__ext__t_1a8a9367bb0305fcf67f2acd236f6eabb6"></span><em class="property">const</em> lv_style_t *<code class="sig-name descname">styles</code>[<code class="sig-name descname">_LV_BTN_STATE_NUM</code>]<a class="headerlink" href="#_CPPv4N12lv_btn_ext_t6stylesE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Styles in each state </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t11ink_in_timeE">
<span id="_CPPv3N12lv_btn_ext_t11ink_in_timeE"></span><span id="_CPPv2N12lv_btn_ext_t11ink_in_timeE"></span><span id="lv_btn_ext_t::ink_in_time__uint16_t"></span><span class="target" id="structlv__btn__ext__t_1a2f049124f07e14731c50631efec82d24"></span>uint16_t <code class="sig-name descname">ink_in_time</code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t11ink_in_timeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>[ms] Time of ink fill effect (0: disable ink effect) </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t13ink_wait_timeE">
<span id="_CPPv3N12lv_btn_ext_t13ink_wait_timeE"></span><span id="_CPPv2N12lv_btn_ext_t13ink_wait_timeE"></span><span id="lv_btn_ext_t::ink_wait_time__uint16_t"></span><span class="target" id="structlv__btn__ext__t_1a18802d6d33dd59454c103ffea66e3481"></span>uint16_t <code class="sig-name descname">ink_wait_time</code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t13ink_wait_timeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>[ms] Wait before the ink disappears </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t12ink_out_timeE">
<span id="_CPPv3N12lv_btn_ext_t12ink_out_timeE"></span><span id="_CPPv2N12lv_btn_ext_t12ink_out_timeE"></span><span id="lv_btn_ext_t::ink_out_time__uint16_t"></span><span class="target" id="structlv__btn__ext__t_1a7f5fda65e792c807e0a4355dba8a5131"></span>uint16_t <code class="sig-name descname">ink_out_time</code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t12ink_out_timeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>[ms] Time of ink disappearing </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t5stateE">
<span id="_CPPv3N12lv_btn_ext_t5stateE"></span><span id="_CPPv2N12lv_btn_ext_t5stateE"></span><span id="lv_btn_ext_t::state__lv_btn_state_t"></span><span class="target" id="structlv__btn__ext__t_1a6c6d725871398b057af897317085ed80"></span><a class="reference internal" href="#_CPPv414lv_btn_state_t" title="lv_btn_state_t">lv_btn_state_t</a> <code class="sig-name descname">state</code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t5stateE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Current state of the button from ‘lv_btn_state_t’ enum </p>
</dd></dl>

<dl class="cpp var">
<dt id="_CPPv4N12lv_btn_ext_t6toggleE">
<span id="_CPPv3N12lv_btn_ext_t6toggleE"></span><span id="_CPPv2N12lv_btn_ext_t6toggleE"></span><span id="lv_btn_ext_t::toggle__uint8_t"></span><span class="target" id="structlv__btn__ext__t_1aa57000fe1113efc6291eabc963c8e2b3"></span>uint8_t <code class="sig-name descname">toggle</code><a class="headerlink" href="#_CPPv4N12lv_btn_ext_t6toggleE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>1: Toggle enabled </p>
</dd></dl>

</div>
</dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="btnm.html" class="btn btn-neutral float-right" title="Button matrix (lv_btnm)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="bar.html" class="btn btn-neutral float-left" title="Bar (lv_bar)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Gabor Kiss-Vamosi
      <span class="lastupdated">
        Last updated on Nov 21, 2020.
      </span>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
  

 <script type="text/javascript">
    $(document).ready(function() {
        $(".toggle > *").hide();
        $(".toggle .header").show();
        $(".toggle .header").click(function() {
            $(this).parent().children().not(".header").toggle(400);
            $(this).parent().children(".header").toggleClass("open");
        })
    });
</script>


<script type="text/javascript" src="https://docs.lvgl.io/misc/common.js"></script>



</body>
</html>